Health checkΒΆ

Health check filter architecture overview.

{
  "name": "health_check",
  "config": {
    "pass_through_mode": "...",
    "endpoint": "...",
    "cache_time_ms": "...",
   }
}

Note that the filter will automatically fail health checks and set the x-envoy-immediate-health-check-fail header if the /healthcheck/fail admin endpoint has been called. (The /healthcheck/ok admin endpoint reverses this behavior).

pass_through_mode
(required, boolean) Specifies whether the filter operates in pass through mode or not.
endpoint
(required, string) Specifies the incoming HTTP endpoint that should be considered the health check endpoint. For example /healthcheck.
cache_time_ms
(optional, integer) If operating in pass through mode, the amount of time in milliseconds that the filter should cache the upstream response.